PAYSLE決済（PAYSLEアプリ方式） API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様（.idPass）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

EntryTranPaysle 取引登録

決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数記号27桁オーダーID
Amount		必須半角数字6桁利用金額利用金額＋税送料が1円～300,000円である必要があります。
Tax		半角数字6桁税送料
PaymentType		必須決済タイプ下記を指定してください。 1：PAYSLEアプリ方式

URL

/payment/EntryTranPaysle.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&Amount=100&PaymentType=1

レスポンス

正常

AccessID		半角英数32桁固定取引ID
AccessPass		半角英数32桁固定取引パスワード

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranPaysle 決済実行

お客様が購入時にPAYSLE決済に必要な情報を入力してから決済依頼します。
当サービスは非同期でPAYSLEに電子バーコード作成依頼を行います。
電子バーコード作成依頼が成功すると、お客様のPAYSLEアプリに支払い用バーコードが表示されます。
（加盟店様が決済実行を実施してから30分～60分程度かかります。）
また、決済依頼を行う前に、お客様のスマートフォンにPAYSLEアプリがインストールされている必要があります。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
OrderID		必須半角英数記号27桁オーダーID
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3
DisplayTermDay		半角数字2桁表示開始日数 PAYSLEアプリでのバーコード表示開始日数です。 0～170まで指定できます。・決済実行日が2018年1月1日の場合表示開始日数に0を指定すると、表示日は2018年1月1日になります。表示開始日数に60を指定すると、表示日は2018年3月2日になります。省略時は、ショップ情報に設定された表示開始日数で処理されます。表示開始日数の初期値は「0」です。変更する際はショップ管理画面より変更してください。
PaymentTermDay		半角数字3桁支払期限日数バーコードの支払期限日数です。 1～170まで指定できます。表示開始日数と同値または大きい値を指定してください。・決済実行日が2018年1月1日の場合支払期限日数に1を指定すると、支払期限日は2018年1月2日になります。支払期限日数に170を指定すると、支払期限日は2018年6月20日になります。省略時は、ショップ情報に設定された支払期限日数で処理されます。支払期限日数の初期値は「30」です。変更する際はショップ管理画面より変更してください。
NotifyTermDay		半角数字2桁購入者通知日数お客様のPAYSLEアプリに支払通知を行う日数です。この日付を元に、「期限まであと×日」というPUSH通知がされます。 1～170まで指定できます。表示開始日数と同値または大きい値、かつ支払期限日数と同値または小さい値を指定してください。・決済実行日が2018年1月1日の場合購入者通知日数に1を指定すると、通知日は2018年1月2日になります。購入者通知日数に170を指定すると、通知日は2018年6月20日になります。省略時は、ショップ情報に設定された購入者通知日数で処理されます。購入者通知日数の初期値は「30」です。変更する際はショップ管理画面より変更してください。
CustomerName		必須全半角20バイト購入者氏名 PAYSLEアプリに表示されます。
CustomerTel		必須半角数字記号13桁購入者携帯電話番号数字、ハイフンで指定してください。
CustomerId		必須半角英数50桁購入者管理ID 支払者を一意に識別するIDです。認証が完了した購入者は、同一事業者からのPAYSLEアプリによる支払いであれば認証行為は最初の注文時の1回のみです。
InvoiceTitle		全半角30バイト請求書タイトル指定した場合PAYSLEアプリに表示されます。未指定の場合契約時に登録した内容が表示されます。 ※使用可能漢字はJIS 第二水準までです。
ItemId		半角数字9桁商品番号（明細）指定した場合PAYSLEアプリに表示されます。
ItemName		全半角20バイト商品名（明細）指定した場合PAYSLEアプリに表示されます。 ※使用可能漢字はJIS 第二水準までです
ItemNumbers		半角数字6桁数量（明細） PAYSLEアプリに表示されます。未指定の場合「1」が設定されます。
ItemFee		半角数字6桁単価（明細） PAYSLEアプリに表示されます。数量を指定した場合、必須です。「数量×単価」と利用金額は一致するように指定してください。未指定の場合は「利用金額」が設定されます。
MultiItem		30000桁複数明細(※1) 複数の商品を指定する場合のみ設定してください。 PAYSLEアプリに表示されます。明細（商品番号、商品名、数量、単価）を12個まで指定することができます。指定した場合は、個別に指定した明細（商品番号、商品名、数量、単価）は無視されます。 UTF-8のXMLフォーマットで作成し、BASE64エンコーディングしてください。複数明細中の「数量×単価の合計額」と利用金額は一致するように指定してください。
PaysleTax		半角数字6桁消費税額 PAYSLEアプリに表示されます。「消費税額＋送料」と税送料は一致するように指定してください。未指定の場合は「税送料」が設定されます。
PaysleShippingFee		半角数字6桁送料 PAYSLEアプリに表示されます。「消費税額＋送料」と税送料は一致するように指定してください。未指定の場合「0」が設定されます。

URL

/payment/ExecTranPaysle.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&CustomerName=山田太郎&CustomerTel=123-4567-8901&CustomerId=customerid001

[XMLフォーマット]

UTF-8でBASE64エンコーディングした値を設定してください。

itemsInfo	商品情報親属性
item	商品明細複数指定することが可能です。
itemId	半角数字9桁商品番号商品を特定する商品番号を設定します。
itemName	全半角20バイト商品名商品を特定する商品名を設定します。※使用可能漢字はJIS 第二水準までとなります。
itemNumbers	必須半角数字6桁数量商品の数量を設定します。XML中の「数量×単価の合計額」と利用金額は一致するように指定してください。
itemFee	必須半角数字6桁単価商品単価を設定します。

XMLヘッダは不要です。
Base64エンコーディングする前のデータが30000バイト以内になるように設定してください。

[XMLサンプル]


<itemsInfo>
    <item>
        <itemId>001</itemId>
        <itemName>商品００１</itemName>
        <itemNumbers>1</itemNumbers>
        <itemFee>1000</itemFee>
    </item>
    <item>
        <itemId>002</itemId>
        <itemName>商品００２</itemName>
        <itemNumbers>2</itemNumbers>
        <itemFee>500</itemFee>
    </item>
</itemsInfo>

レスポンス

正常

OrderID		半角英数記号27桁オーダーID
Status		現状態処理成功時は以下のステータスが返却されます。 REQSUCCESS：要求成功
TranDate		半角数字14桁固定決済日付 yyyyMMddHHmmss形式
PaysleDisplayTerm		半角数字8桁固定表示開始日 PAYSLEアプリでのバーコード表示開始日を返却します。 yyyyMMdd形式
PayslePaymentTerm		半角数字8桁固定支払期限日バーコードの支払期限日を返却します。 yyyyMMdd形式
PaysleNotifyTerm		半角数字8桁固定購入者通知日お客様のPAYSLEアプリへの支払通知日です。 yyyyMMdd形式
CheckString		半角英数32桁 MD5ハッシュ OrderID,AccessID,ShopID,ShopPassを連結しMD5ハッシュした値を返却します。

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=REQSUCCESS&TranDate=20220801121212&PaysleDisplayTerm=20220801&PayslePaymentTerm=20220810&PaysleNotifyTerm=20220801&CheckString=660e54b845g14ed03e8cf807a6skjh87

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

PaysleCancel 支払停止

支払停止処理を受け付けます。非同期でPAYSLEに電子バーコードの取消処理を行います。
電子バーコード取消処理が成功すると、PAYSLEアプリの未支払一覧からバーコードが削除され、注文取消が発生した旨の「お知らせ」が通知されます。（加盟店様が支払停止を実施してから30分～60分程度かかります。）

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
OrderID		必須半角英数記号27桁オーダーID

URL

/payment/PaysleCancel.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001

レスポンス

正常

OrderID		半角英数記号27桁オーダーID
Status		現状態成功時は以下のステータスが返却されます。 REQCANCEL：支払停止受付

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=REQCANCEL

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

指定したオーダーIDの取引情報を取得します。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数記号27桁オーダーID
PayType		必須半角数字2桁決済方法 35：PAYSLE

URL

/payment/SearchTradeMulti.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=35

レスポンス

正常

Status		現状態 UNPROCESSED：未決済 REQSUCCESS：要求成功 PAYWAITING：支払待ち PAYSUCCESS：決済完了 PAYFAIL：決済失敗 REQCANCEL：支払停止受付 CANCEL：支払停止
ProcessDate		半角数字14桁固定処理日時 yyyyMMddHHmmss形式
AccessID		半角英数32桁固定取引ID
AccessPass		半角英数32桁固定取引パスワード
Amount		半角数字10桁利用金額
Tax		半角数字10桁税送料
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3
PayType		半角数字2桁決済方法 35：PAYSLE
PaysleDisplayTerm		半角数字8桁固定表示開始日 PAYSLEアプリでのバーコード表示開始日を返却します。 yyyyMMdd形式
PayslePaymentTerm		半角数字8桁固定支払期限日バーコードの支払期限日を返却します。 yyyyMMdd形式
PaysleNotifyTerm		半角数字8桁固定購入者通知日お客様のPAYSLEアプリへの支払通知日です。 yyyyMMdd形式
PaysleOrderSerial		18桁注文管理ID
PaysleResultCode		半角数字1桁固定収納結果 1：支払い 2：確定 3：支払取消
FinishDate		半角数字14桁固定入金日時お客様がコンビニでお支払いをした日時です。 yyyyMMddHHmmss形式

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

Status=PAYSUCCESS&ProcessDate=20220801121212&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=100&Tax=0&ClientField1=&ClientField2=&ClientField3=&PayType=35&PaysleDisplayTerm=20220801&PayslePaymentTerm=20220810&PaysleNotifyTerm=20220801&PaysleOrderSerial=123456&PaysleResultCode=2&FinishDate=20220801121212

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

PAYSLE決済